GET
:用來請求資源。請求通常不包含body。
GET /users/123 HTTP/1.1
Host: example.com
POST
:用來提交資料。請求包含body,通常用於創建新資源。
POST /users HTTP/1.1
Host: example.com
Content-Type: application/json
{
"name": "John Doe",
"email": "john.doe@example.com"
}
PUT
:用來更新現有資源。請求包含body。
PUT /users/123 HTTP/1.1
Host: example.com
Content-Type: application/json
{
"name": "John Smith",
"email": "john.smith@example.com"
}
DELETE
:用來刪除資源。請求通常不包含body。
DELETE /users/123 HTTP/1.1
Host: example.com
URL(統一資源定位符)指定請求的資源。範例:
https://api.example.com/users/123
請求標頭提供有關請求的資料:
Content-Type
:指定請求body的媒介類型,如 application/json
。Authorization
:用於提供身份驗證信息,例如 Bearer <token>
。Accept
:指定客戶端能處理的媒介類型,如 application/json
。在 POST
或 PUT
請求中,body通常包含要提交的資料。例如:
{
"name": "Alice",
"age": 30
}
狀態碼顯示請求的結果:
200 OK
:請求成功,通常返回請求的資源或結果。201 Created
:請求成功,資源已創建(通常與 POST
一起使用)。204 No Content
:請求成功,但沒有返回內容(通常與 DELETE
一起使用)。400 Bad Request
:請求無效,請檢查請求的語法或資料。401 Unauthorized
:需要身份驗證。403 Forbidden
:沒有權限訪問資源。404 Not Found
:請求的資源不存在。500 Internal Server Error
:伺服器出現錯誤。回應標頭提供有關回應的Metadata:
Content-Type
:回應body的媒介類型,如 application/json
。Set-Cookie
:設置 cookie。響應body包含請求的結果或錯誤信息。例如:
{
"userId": 123,
"name": "John Doe"
}
API 是一組定義如何進行應用程序交互的規則和協議。它使得不同系統能夠互相溝通和操作資料。
API 端點是可以訪問的特定 URL,用於執行操作。例如:
GET https://api.example.com/users
請求參數可以在 URL 中傳遞(查詢參數)或在body中(對於 POST
和 PUT
)。例如:
GET https://api.example.com/users?age=30
POST
或 PUT
請求):
{
"name": "Alice",
"age": 30
}
API 通常需要身份驗證以確保安全性。常見的身份驗證方法包括: